home *** CD-ROM | disk | FTP | other *** search
/ AMIGA PD 1 / AMIGA-PD-1.iso / Aminet / Aminet / util / cli / filefind.lha / File Finder.doc next >
Text File  |  1995-02-02  |  11KB  |  378 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                                               01108730-0
  7.  
  8.  
  9.                                                 Version
  10.                                                   1.0
  11.  
  12.  
  13.  
  14.  
  15.                                               Mark Melton
  16.  
  17.  
  18.  
  19.                                                  ©1995
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.                                       Generated with Heddley v1.1
  37.                                    Heddley v1.1 (C) Edd Dumbill 1994
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.                                               - Page 1 -
  77.  
  78.  
  79.  
  80. 1.    File Finder
  81.  
  82.                                      File Finder 
  83.                          Release Version 1.05 2nd Feb 1995 
  84.                              written by Mark Melton 
  85.                email u9326383@radon.sys.uea.ac.uk (until July 96)
  86.  
  87.  
  88. Contents 
  89.  Copyright 
  90.  Introduction 
  91.  Requirements 
  92.  Installation 
  93.  Usage 
  94.  Problems
  95.  Future plans 
  96.  Acknowledgements 
  97.  Suggestions/Registration
  98.  
  99. 2.    Copyright
  100.  
  101.                                          Copyright
  102.  
  103. This product may be freely distributed as long as certain conditions are met.
  104.  
  105. 1. This product may only be distributed in a compleat form this doc file including copyright message  m
  106. ust be included .
  107.  
  108. 2. This product may be freely distributed via the internet or any other non commercial venture.  
  109.  
  110. 3. This program my only be distributed by a commercial PD library only with my express
  111. permission, for  which a charge will be made.
  112.  
  113. 4. No charge may be made for the distribution of this product except for a nominal fee for the media on
  114.     which  it is  transmitted, without my permission.
  115.  
  116. 5. This product may not be included on any magazine coverdisk without my written consent, except for th
  117.  e   Amiga Shopper magazine  based in the UK.
  118.  
  119. 6. This product will not be included in any commercial package, unless my written consent is obtained  
  120.    before distribution.
  121.  
  122. By distributing, using or copying the product you indicate your acceptance of the above conditions.
  123.  
  124. Disclaimer
  125.  
  126. This program is provided as is, and no liability is accepted for any dammage caused to you, your  machi
  127.  ne,  or for that matter anything else. Hey if using this program causes WW3 don't blame me OK.
  128.  
  129. 3.    Introduction
  130.  
  131. Introduction
  132.  
  133. This program is used for finding things,  still you probably worked that out from the name ;-).
  134. I wrote it mainly  because I have access to several Amigas (TM), with rather
  135. large hard-drive's. I found there was a need to quickly  find the location of files on
  136. the machines as many of them have files stored in different ways.  There was also 
  137. the article in the Amiga Shopper magazine on a file finding utility. I modified their code a bit and
  138. added  substantial amounts, and came up with this program.
  139.  
  140.  
  141. Current features in version 1.1
  142.  
  143. Find any file on a disk, using standard AmigaDos(TM) file matching patterns.
  144.  
  145. Fully implemented as a commodity, with hotkey etc.
  146.  
  147.                                               - Page 2 -
  148. 3.    Introduction
  149.  
  150.  
  151. Limit search  size parameters, only files in a certain size range are checked.
  152.  
  153.  + a few bug fixes ;->
  154.  
  155. 4.    Requirements
  156.  
  157. Requirements for File Finder.
  158.  
  159. It is essential that you have at least kickstart & Workbench 2.04.
  160.  
  161. Other than that there are no further restrictions, well appart from having an amiga :-).
  162.  
  163. The program has been written on an A1200 with 50Mhz GVP A1230-II.
  164. It has been tested using enforcer and  causes no enforcer hits so it should be OK on all amigas.
  165.  
  166. Tested on plain A1200, A4000/040, A4000/030/ and an A3000.  I would be grateful for people to
  167. confirm its operation  on other machines, e.g. A500+, A2000, etc.
  168.  
  169. 5.    Usage
  170.  
  171. Usage
  172.  
  173. This program was designed with one goal in mind, to be simple to use.  It
  174. is for this reason that the standard "look" of the workbench has been used.  The program has
  175. three main interface area's. The file list at the top (initialy blank),  the search pa ameter
  176. control's, contailed within the "raised" box, and the program control functions at the bottom.  A
  177. screen shot of this is included and can be viewed by pressing this button in WB3.0 or above, or by
  178. using the display in the utilities drawer.
  179.  
  180. Firstly the Search parameter gadgets will be described.  
  181.  
  182. The status gadget informs the user of the current status of the program.
  183. It is not selectable by ths user.
  184.  
  185. The Path gadget, keyboard shortcut P, is used to specify the drive or
  186. directory in which to look for the file. Limiting the search to a particular directory saves time
  187. by reducing the number of files which have to be searched.   e.g.
  188.  
  189. DH0:
  190.  
  191. This would search all of DH0:,  whereas
  192.  
  193. DH0:Utilities/
  194.  
  195. would only search the directory dh0:utilities.
  196.  
  197.  
  198. The Pattern gadget, keyboard shortcut T, is used to specify the
  199. file for which to search. Standard AmigaDOS file patterns are accepted, to save you digging out
  200. your AmigaDOS manual, if you even have one, here are the pattern's
  201.  
  202. ?               Matches any single character.
  203.  
  204. #<p>            Matches zero or more occurances of <p>.
  205.  
  206. <p1>|<p2>       Matches if either <p1> or <p2> matches.
  207.  
  208. -<p>            Matches everything but <p>.
  209.  
  210. (<p1><p2>...)   Groups items together.
  211.  
  212. %               Matches the null string.
  213.  
  214. [<p>-<p>]       Determines a character range.
  215.  
  216. Now unless you've used AmigaDOS extensivly, that lot will be about as
  217.  
  218.                                               - Page 3 -
  219. 5.    Usage
  220.  
  221. clear as mud. So here's the english translation.
  222.  
  223. A?B             Matches any three letter word begining in A and ending in
  224. B. Such as AcB, AzB, ABB, etc.
  225.  
  226. A#BC            Matches any name beginning in A and ending in C, with
  227. any number of B's in between. Such as ABC, ABBC, ABBBC, etc.
  228.  
  229. ABC#?           Matches any name beginning ABC. Such as ABCD, ABCPIC.info, etc.
  230.  
  231. #?XYZ           Matches any name ending XYZ. Such as MARK_XYZ, PICXYZ, etc.
  232.  
  233. ABC#?XYZ        Matches any name beginning ABC and ending XYZ. Such as ABCXYZ, ABCMARKXYZ, etc.
  234.  
  235. A(B|C)D         Matches ABD or ACD.
  236.  
  237. ~(XYZ)          Matches anything but XYZ.
  238.  
  239. ~(#?.info)      Matches anything not ending in .info.
  240.  
  241. A#(BC)          Matches any name begining with A followed by any number
  242. of BC's. Such as ABC, ABCBC, ABCBCBC, etc.
  243.  
  244. A(B|D|%)C       Matches any name starting with A ending with C with B, D
  245. or nothing in between. Such as ABC, ADC or AC.
  246.  
  247. [A-D]#?         Matches any name beginning with A, B, C or D.
  248.  
  249.  
  250.  
  251. The Size button, keyboard shortcut S, opens the Search Size
  252. limit window containing three gadgets. They are the info gadget, which is a small reminder of what to
  253. do. The Max Size gadget, keyboard shortcut M, where the maximum file size to include in the search is
  254. put, and the Min Size gadget, keyboard shortcut S, where the minimum  file size to inculde in the
  255. search is put. The search size limit window does not have to be closed after use and can be left open.
  256. To ignore a maximum file size limit enter a value of 0. e.g.
  257.  
  258. Max size = 0 Min size = 1000
  259.  
  260. would only look for files over 1000 bytes (1Kb) in size. 
  261.  
  262. Max size = 10000 Min size = 5000
  263.  
  264. would only look for files over 5000 bytes (5Kb) long but under 10000 bytes (10 Kb).
  265.  
  266.  
  267. The List Gadget.
  268.  
  269. This is where the list of files that match the search parameters will
  270. appear. If the list gadget is clicked on, details of the file selected, will appear in the
  271. info window. This provides details such as the creation date of the file, its name, the pat
  272.  to the file  and its size.  The info window can be left open when
  273. selecting other files, there details will replace those already in the info window. Program control
  274. gadgets.
  275.  
  276. Quit, keyboard shortcut Q, exits the program immediatly.  Warning, you will
  277. not be asked to confirm a quit request.
  278.  
  279. Find, keyboard shortcut F, commences the search with the current search parameters.
  280.  
  281. Abort, keyboard shortcut A, aborts the current search operation.  This
  282. will stop the search at the point it had reached when the abort button was pressed.  Search
  283. operations must be allowed to compleat or aborted before any other commands can be used, su h as Quit.
  284.  
  285. Print, keyboard shortcut R, print's the current contents of the list to the current prefs printer.
  286.  
  287.  
  288.  
  289.                                               - Page 4 -
  290. 5.    Installation
  291.  
  292.  
  293. 6.    Installation
  294.  
  295. Installation
  296.  
  297. This couldn't possibly be easier.  Simply drag the File Finder icon to
  298. wherever you want it to be put. I would recomend either your utilities drawer, tools drawer or
  299. preferbly your WBStartup drawer.   
  300.  
  301. The documentation  consists of the AmigaGuide format doc, and a plain text file.  Also there is also
  302. a picture of  the interface this should ideally be kept in the same place as the amigaguide doc.
  303.  
  304. New to version 1.05.
  305.  
  306. TOOLTYPES
  307.  
  308. (See page 10-23 of the WorkBench 3.0 manual.)
  309.  
  310. CX_HOTKEY="ctrl F" or any other combination you want.  This key combination will cause the program
  311. to popup its GUI(Graphical user interface) if it is currently "Hidden".
  312.  
  313. Use the tooltype  DONOTWAIT if you run the program from the WBStartup drawer.
  314.  
  315. The  CX_POPUP tooltype determinew if the program opens its GUI on startup.
  316.  
  317. 7.    Problems
  318.  
  319. Problems
  320.  
  321. Well, there are no known problems with this program.
  322.  
  323. If you discover any problems with this program send me the details,
  324. such as what the problem is, what sort of machine you use machine, you KS and WB version numbers
  325. and an address where you can be contacted.
  326.  
  327. 8.    Future plans
  328.  
  329. Future plans
  330.  
  331. Firstly to implement the date limit (nearly done), and type limit features.
  332.  
  333. You never know, some shareware subscriptions might encorage me to get these features implemented :->
  334.  
  335. Also I would welcome any suggestions for improvements or new features.
  336.  
  337. Contacts
  338.  
  339. 9.    Acknowledgements
  340.  
  341. Acknowledgements
  342.  
  343. Thanks go to the Amiga Shopper magazine in the UK for
  344. providing the inspiration for this program. This program is loosly based on a program that they ran as
  345. a C programming tutorial, but has had considreable enhancements, and extra features added.
  346.  
  347. 10.    Suggestions/Registration
  348.  
  349. Firstly I can be contacted by Email or snail mail.
  350.  
  351. Email (Bugs, sugestions only)
  352.  
  353. u9326383@radon.sys.uea.ac.uk
  354.  
  355. I will have access to this account until at least summer 1996.
  356.  
  357. Snail mail( registration requests, bugs, sugestions)
  358.  
  359.  
  360.                                               - Page 5 -
  361. 10.    Suggestions/Registration
  362.  
  363.  Mr M D Melton,  
  364.  1 Hawksmoor close,  
  365.  North Hykeham, 
  366.  Lincoln, 
  367.  England,
  368.  LN6 9PN
  369.  
  370. Registration
  371.  
  372. What benifits will registration bring you, well appart from making you only very slightly poorer, it wi
  373.    ll brin   g my eternal gratitude, and the very latest version of this program. What do I ask for thi
  374. s  program, which has   been written in my spare time w hile studying for my degree, as a possible
  375. method of suplementing my income :->
  376.  
  377. Full registration £15, yes thats all, just 15 GB pounds, 40 DM or $25.
  378.